Skip to content

docs(contributing): clarify verified CI requirement - #12763

Merged
dagil-nvidia merged 5 commits into
ai-dynamo:mainfrom
kristinapathak:kpathak/docs-verified-commit-ci
Sep 1, 2026
Merged

dagil-nvidia merged 5 commits into
ai-dynamo:mainfrom
kristinapathak:kpathak/docs-verified-commit-ci

Conversation

@kristinapathak

@kristinapathak kristinapathak commented Aug 6, 2026 •

Copy link
Copy Markdown

Summary

Validation

  • git diff --check
  • uv run --no-project --with PyYAML python3 scripts/validate_skills.py

Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Added guidance for fork pull requests requiring every commit to have a GitHub-verified cryptographic signature.
    • Clarified that DCO sign-off alone is insufficient for automatic testing approval.
    • Added troubleshooting steps for identifying and resolving unverified commits.

@kristinapathak
kristinapathak requested review from a team as code owners August 6, 2026 17:00
@copy-pr-bot

copy-pr-bot Bot commented Aug 6, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 6, 2026 17:00 — with GitHub Actions Inactive
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 6, 2026 17:00 — with GitHub Actions Inactive

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

Open in Devin Review

Comment thread CONTRIBUTING.md Resolved
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bbaea7b1-5ce9-405d-9c49-198dcfe43019

📥 Commits

Reviewing files that changed from the base of the PR and between 42ec62e and b0d5d2a.

📒 Files selected for processing (3)
  • .agents/skills/pr-monitor/SKILL.md
  • AGENTS.md
  • CONTRIBUTING.md

Walkthrough

The documentation updates define GitHub-verified signatures on every fork pull request commit as a prerequisite for automatic trusted-CI approval. The PR monitor guidance adds verification commands, summary text, and remediation instructions for unverified commits.

Changes

Fork CI verification

Layer / File(s) Summary
Document fork approval requirements
AGENTS.md, CONTRIBUTING.md
Documents DCO sign-off and GitHub-verified cryptographic signatures for every fork pull request commit. Unverified commits block automatic /ok to test approval.
Add monitoring checks and remediation steps
.agents/skills/pr-monitor/SKILL.md
Adds commands to inspect commit verification, an actionable summary for unverified signatures, and instructions to sign and rewrite affected commits.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The PR documents DCO sign-off and GitHub-verified signatures for fork CI, but the provided context does not confirm a link to GitHub signing instructions. Confirm that the contributor documentation includes a link to GitHub's commit-signing instructions.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change for the verified CI requirement.
Description check ✅ Passed The description covers the purpose, implementation details, validation, and required issue link, although it uses a custom section layout.
Out of Scope Changes check ✅ Passed All changes support the linked issue and remain within the requested fork pull request documentation scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Comment @coderabbitai help to get the list of available commands.

@kristinapathak
kristinapathak requested a review from a team as a code owner August 6, 2026 17:19
@pull-request-size pull-request-size Bot added size/M and removed size/S labels Aug 6, 2026
@github-actions github-actions Bot added the docs label Aug 6, 2026
@github-actions

github-actions Bot commented Aug 6, 2026 •

Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot added external-contribution Pull request is from an external contributor documentation Improvements or additions to documentation labels Aug 6, 2026
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 11, 2026 19:22 — with GitHub Actions Inactive
@datadog-official

datadog-official Bot commented Aug 11, 2026 •

Copy link
Copy Markdown

Tests

🔄 Datadog auto-retried 1 job - 1 passed on retry View in Datadog

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 673bd09 | Docs | Datadog PR Page | Give us feedback!

@kristinapathak
kristinapathak force-pushed the kpathak/docs-verified-commit-ci branch from c147828 to 0281aae Compare August 11, 2026 19:32
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 11, 2026 19:32 — with GitHub Actions Inactive
@dynamo-ops

Copy link
Copy Markdown
Contributor

/ok to test 0281aae

@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 11, 2026 19:45 — with GitHub Actions Inactive
@pull-request-size pull-request-size Bot added size/L and removed size/M labels Aug 11, 2026
@dynamo-ops

Copy link
Copy Markdown
Contributor

/ok to test c65121f

@harryskim harryskim left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving — the added prose is accurate against .github/workflows/trigger-ci-approval-flow.yml, and the pages/reference/api/python/* churn is expected generator output.

Non-blocking follow-ups, happy for these to land separately:

  1. The English side got this in one place (dco-and-licensing.md) while the zh-CN overview got it in two. The English counterparts of both zh-CN spots are untouched: getting-started.mdx (Configure DCO sign-off step) and contribution-flow.mdx (Complete automated review and CI step). getting-started.mdx is the setup page contributors are routed to, so it's the highest-value place for the note.
  2. /ok to test appears nowhere else in docs/fern/pages, so the new section references an undefined term for English readers. The zh-CN overview defines it, which is why it reads fine there.
  3. Two things the workflow does that the docs don't say: signing alone isn't sufficient (a contributor not in APPROVED_EXTERNAL_CONTRIBUTORS never gets automatic approval regardless of signatures), and a maintainer can still post /ok to test <sha> manually — the bot's own comment tells contributors they don't need to rewrite commits for that path. Without #3, expect "I signed everything, why no CI?" reports and unnecessary branch-wide re-signing.

Minor: the new section splits the page's Create -> Verify -> Repair spine ("Repair the Latest Commit" now reads as if it repairs the signing problem); Verified is bold in CONTRIBUTING.md but backticked elsewhere; and the Devin comment about the DCO page not being updated is stale.

@kristinapathak
kristinapathak force-pushed the kpathak/docs-verified-commit-ci branch from c65121f to 1b13726 Compare August 17, 2026 17:36
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 17, 2026 17:36 — with GitHub Actions Inactive
Signed-off-by: Kristina Pathak <kristina.m.pathak@gmail.com>
Signed-off-by: Kristina Pathak <kristina.m.pathak@gmail.com>
Signed-off-by: Kristina Pathak <kristina.m.pathak@gmail.com>
@kristinapathak
kristinapathak force-pushed the kpathak/docs-verified-commit-ci branch from 1b13726 to 673bd09 Compare August 17, 2026 17:37
@pull-request-size pull-request-size Bot added size/M and removed size/L labels Aug 17, 2026
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 17, 2026 17:37 — with GitHub Actions Inactive
@kristinapathak
kristinapathak temporarily deployed to external_collaborator August 19, 2026 20:05 — with GitHub Actions Inactive
@dynamo-ops

Copy link
Copy Markdown
Contributor

/ok to test 19cd52f

@dagil-nvidia dagil-nvidia left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving: all gates green at head 19cd52f (skills validation proven with a known-positive, CODEOWNERS drift 0, strict coverage, 93 matcher tests, docs linter proven with an injected-H1 probe), and the governance wording was fact-checked clause by clause against .github/workflows/trigger-ci-approval-flow.yml, the ground truth: the fork-only condition, all three approval paths, the every-commit-Verified requirement, the signature-check-after-approval ordering ("signing commits does not create that path" is exactly right), the unsigned-commit comment, and the manual /ok to test <sha> fallback all match. Every added sentence keeps the external-contribution gate closed, and the scope constraint from issue #12761 is honored on all five English surfaces plus the zh-CN page. The earlier review's follow-ups are all addressed at this head.

Three non-blocking notes:

  1. .agents/skills/pr-monitor/SKILL.md:57 - the documented verification check makes N+1 API calls; .commit.verification is already in the commits-list response. Verified live on this PR that the one-call form returns identical output: gh api --paginate "repos/ai-dynamo/dynamo/pulls/$PR_NUMBER/commits?per_page=100" --jq '.[] | "\(.sha[0:7]) verified=\(.commit.verification.verified) reason=\(.commit.verification.reason)"'.
  2. AGENTS.md:148 - "the automatic approval flow posts that command" refers back to a definition that says "with the short SHA", but the workflow posts the full 40-character head SHA. Behavior unaffected; the referent reads wrong. Suggest "...posts the same command with the full head SHA only after every PR commit is GitHub-verified."
  3. .agents/skills/pr-monitor/SKILL.md:50 - reason 3 packs flow, requirement, diagnosis, fix, and fallback into one five-sentence bullet while its siblings are one-liners; keep the reason line short and move the detail into the preceding paragraph.

Pre-existing, untouched lines: the internal-looking nvevents.nvidia.com links the linter warns about, and the structural EN/zh divergence of the legacy zh-CN overview page (updating it in place was the only option).

Automated review pass; severity escalation stays with the human reviewers.

@dagil-nvidia
dagil-nvidia temporarily deployed to external_collaborator September 1, 2026 14:24 — with GitHub Actions Inactive
@dynamo-ops

Copy link
Copy Markdown
Contributor

/ok to test 3a82369

@dagil-nvidia

Copy link
Copy Markdown
Collaborator

Is this targeted for v1.5.0? Code freeze is today at 3:00 PM PT - to make the release it needs to merge to main by then.

@dagil-nvidia

Copy link
Copy Markdown
Collaborator

/ok to test 3a82369

@dagil-nvidia
dagil-nvidia merged commit 6156e2c into ai-dynamo:main Sep 1, 2026
93 checks passed
milesial pushed a commit to milesial/dynamo that referenced this pull request Sep 2, 2026
Signed-off-by: Kristina Pathak <kristina.m.pathak@gmail.com>
Co-authored-by: Dan Gil <dagil@nvidia.com>

This branch was previously deployed

1 inactive deployment
external_collaborator — 3a823692 Deployed Sep 1, 2026 by dagil-nvidia via ok-to-test #14076
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation external-contribution Pull request is from an external contributor size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document verified commit signatures for automatic fork CI

5 participants